home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / slqd220.zip / SLQDOOR.DOC < prev    next >
Text File  |  1992-04-28  |  16KB  |  591 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                  SLQDoor 2.20
  20.  
  21.              Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  22.  
  23.                Created with the Searchlight Programmer's Library
  24.                Portions Copyright (c) 1991 Searchlight Software
  25.  
  26.                      Designed & Written by Jack Ridgway
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.                                    Page 1
  58.  
  59.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  60.  
  61.  
  62.  
  63.  
  64.    CONTENTS
  65.  
  66.      Disclaimer .....................................................  3
  67.  
  68.      Shareware Agreement ............................................  3
  69.  
  70.      Distribution Archive Contents ..................................  4
  71.  
  72.      Additional Files ...............................................  4
  73.  
  74.      What Does SLQDoor Do? ..........................................  4
  75.  
  76.      Requirements ...................................................  5
  77.  
  78.      Configuration ..................................................  5
  79.  
  80.      How to Run SLQDoor .............................................  6
  81.  
  82.      Using Time Doors ...............................................  7
  83.  
  84.      Using PCBVerify ................................................  8
  85.  
  86.      The Log File ...................................................  9
  87.  
  88.      Errorlevels ....................................................  9
  89.  
  90.      Registration ...................................................  9
  91.  
  92.      Technical Support .............................................. 10
  93.  
  94.      Other Door Formats ............................................. 10
  95.  
  96.      Future Enhancements ............................................ 10
  97.  
  98.      Acknowledgements ............................................... 10
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.                                    Page 2
  117.  
  118.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  119.  
  120.  
  121.  
  122.  
  123.    DISCLAIMER
  124.  
  125.      Users of SLQDoor must accept this disclaimer of warranty: "SLQDoor
  126.      is supplied as is.  The author disclaims all warranties, expressed
  127.      or implied, including, without limitation, the warranties of
  128.      merchantability and of fitness for any purpose.  The author assumes
  129.      no liability for damages, direct or consequential, which may result
  130.      from the use of SLQDoor."
  131.  
  132.  
  133.    SHAREWARE AGREEMENT
  134.  
  135.      SLQDoor is a "shareware program" and is provided at no charge to
  136.      the user for evaluation.  Feel free to share it with your friends,
  137.      but please do not give it away altered or as part of another
  138.      system.  The essence of "user-supported" software is to provide
  139.      personal computer users with quality software without high prices,
  140.      and yet to provide incentive for programmers to continue to develop
  141.      new products.  If you find this program useful and find that you
  142.      are using it and continue to use it after a reasonable trial period
  143.      of thirty days, then you must register it.  The registration fee
  144.      will license one copy for use on any one computer at any one time.
  145.      You must treat this software just like a book.  An example is that
  146.      this software may be used by any number of people and may be freely
  147.      moved from one computer location to another, so long as there is no
  148.      possibility of it being used at one location while it's being used
  149.      at another.  Just as a book cannot be read by two different persons
  150.      at the same time.
  151.  
  152.      Commercial users of SLQDoor must register and pay for their copies
  153.      of SLQDoor within thirty days of first use or their license is
  154.      withdrawn.  A BBS operated for profit IS a commercial environment;
  155.      however, a subscription system not operated for profit is not
  156.      considered a commercial environment in relation to this agreement.
  157.      Site-License arrangements may be made by contacting A.B.S.  Anyone
  158.      distributing SLQDoor for any kind of remuneration must first
  159.      contact A.B.S. at the address listed below for authorization.  This
  160.      authorization will be automatically granted to distributors
  161.      recognized by the (ASP) as adhering to its guidelines for shareware
  162.      distributors, and such distributors may begin offering SLQDoor
  163.      immediately; however, A.B.S. must still be advised so that the
  164.      distributor can be kept up-to-date with the latest version of
  165.      SLQDoor.
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.                                    Page 3
  176.  
  177.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  178.  
  179.  
  180.  
  181.  
  182.    DISTRIBUTION ARCHIVE CONTENTS
  183.  
  184.      You will find the following files in SLQD220.*
  185.  
  186.        SLQDOOR.EXE
  187.        SLQDOOR.DOC
  188.        SLQDOOR.CFG
  189.        WHATS.NEW
  190.        REGISTER.FRM
  191.  
  192.  
  193.    ADDITIONAL FILES
  194.  
  195.      SLQDoor creates/uses door drop files for each BBS/Door type.
  196.      Unless specifically noted, SLQDoor does not delete any files.
  197.  
  198.  
  199.    WHAT DOES SLQDoor DO?
  200.  
  201.      SLQDoor will create door drop files for the following:
  202.  
  203.      Door Type                 Keyword    Files Created
  204.      --------------------------------------------------------------------
  205.      Log Entry Into a Door      LOG       NONE
  206.      Auntie                     AUNTIE    Auntie.sys
  207.      2AM                        2AM       Jumper.dat
  208.      GAP                        GAP       Door.sys
  209.      GT Power                   GT        Gtuser.bbs
  210.      Milton Gameworks Doors     MG        Userinfo.txt
  211.      Operation Overkill II      OOII      Bbsinfo.oo
  212.      PCBoard 12.x               PCB12     Pcboard.sys, Pcboard.dat, Users
  213.      PCBoard 14.x               PCB14     Pcboard.sys, Pcboard.dat, Users
  214.      PCBVerify 4.xx             PCBV      Pcbv[x].sys
  215.      QuickBBS 2.75              QBBS      Dorinfo1.def, Exitinfo.bbs
  216.      RemoteAccess 1.10          RA        Dorinfo1.def, Exitinfo.bbs
  217.      RBBS-PC                    RBBS      Dorinfo[x].def
  218.      Spitfire                   SPIT      Sfdoors.dat
  219.      Solar Realm Doors          SR        Doorfile.sr
  220.      Tritel 2.xx                TRI       Tritel.sys
  221.      WildCat 2.xx               WC2       Callinfo.bbs
  222.      WildCat 3.x                WC3       Door.sys, Userinfo.dat
  223.      WWIV                       WWIV      Chain.txt
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.                                    Page 4
  235.  
  236.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  237.  
  238.  
  239.  
  240.  
  241.      SLQDoor will read in door drop files for the following:
  242.  
  243.      Door Type                 Keyword    Files Read
  244.      --------------------------------------------------------------------
  245.      Log Exit From a Door       !LOG      NONE
  246.      GAP                        !GAP      Door.sys
  247.      PCBV                       !PCBV     Reg[x]
  248.      QuickBBS 2.75              !QBBS     Exitinfo.bbs
  249.      RemoteAccess 1.10          !RA       Exitinfo.bbs
  250.  
  251.      After reading in a drop file, the users time for that session and
  252.      time for that day is updated, if changed.  For PCBVerify, the user
  253.      is also updated to the Validated User status in Config.sl2.
  254.      SLQDoor is Session Time Limit and Event Aware.
  255.  
  256.  
  257.    REQUIREMENTS
  258.  
  259.      SLQDoor should run on any system running MS-DOS 3.3 or higher with
  260.      at least 100K free RAM.  It uses the Direct Video setting from
  261.      CONFIG.SL2 for direct screen writes.  It will write to the virtual
  262.      screen buffer if a supported multi-tasker is detected and direct
  263.      screen writes are enabled.
  264.  
  265.      SLQDoor requires an SLBBS environment variable to function properly.
  266.      It is SLBBS=[path to config.sl2].  This makes multinode usage easy.
  267.  
  268.  
  269.    CONFIGURATION
  270.  
  271.      SLQDoor requires a configuration file.  You can edit the sample
  272.      SLQDOOR.CFG included in the archive, or create a new one, with
  273.      any ASCII text editor.  Place SLQDOOR.CFG in the SLQDoor directory.
  274.  
  275.      The format for SLQDOOR.CFG is:
  276.  
  277.      0000       <- Registration Number
  278.      Jack       <- Your First Name - up to 15 characters - REQUIRED
  279.      Ridgway    <- Your Last Name - up to 15 characters - may be blank
  280.      0532       <- Your Searchlight Registration Number - MUST BE 4 DIGITS!
  281.  
  282.      The total number of characters for your first and last name
  283.      combined must not exceed 25.  You can not use any spaces in your
  284.      name.
  285.  
  286.      If SLQDOOR.CFG is not found, then SLQDoor will NOT run!
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.                                    Page 5
  294.  
  295.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  296.  
  297.  
  298.  
  299.  
  300.    HOW TO RUN SLQDoor
  301.  
  302.      SLQDOOR [path to write drop file]\[keyword] [doorname]
  303.  
  304.      to make a GAP Door.sys in D:\DOORS:
  305.  
  306.      SLQDOOR D:\DOORS\GAP [doorname]
  307.  
  308.      Case is not important.  If the path to write drop file is left out,
  309.      the current directory is used.  If doorname is left out, 'LOG' is
  310.      used in it's place.  The maximum length of doorname is 8 characters,
  311.      and it can not contain any spaces.
  312.  
  313.      To make a Spitfire Sfdoors.dat in the current directory, with no door
  314.      name logged:
  315.  
  316.      SLQDOOR SPIT
  317.  
  318.  
  319.      SLQDoor will normally be run in a batch file that runs a door.
  320.  
  321.      Here's an example:
  322.  
  323.      I want to run Yankee Trader on my SLBBS, and it is a QuickBBS door.
  324.  
  325.      In my doors.def file:
  326.      0;0;0;5;Yankee Trader;D:\DOORS\YANKEE;TRADER.BAT
  327.  
  328.      Trader.bat:
  329.      @echo off
  330.      SLQDOOR QBBS YT
  331.      yt
  332.      SLQDOOR !LOG YT  <- covered later in the documentation
  333.  
  334.      To read in a drop file, SLQDoor would also be run in the
  335.      batch file after the door runs.
  336.  
  337.      Here's another example:
  338.  
  339.      I want to run RATS (RA Time Bank) on my SLBBS.
  340.  
  341.      In my doors.def file:
  342.      0;0;0;5;RATS;D:\DOORS\RATS;RATS.BAT
  343.  
  344.      Rats.bat:
  345.      @echo off
  346.      SLQDOOR RA RATS
  347.      ratime
  348.      SLQDOOR !RA RATS
  349.  
  350.  
  351.  
  352.                                    Page 6
  353.  
  354.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.      For a fully functional door logging/reporting facility, it is
  362.      recommended that SLQDoor be run for EVERY door you run, even if
  363.      no conversion is necessary.  This will allow you to keep track of
  364.      which doors are used, by whom, and which CRASH!  To do this, use
  365.      the LOG keyword when no conversion is needed, or when exiting from
  366.      the door and you don't want to read in the drop file.
  367.  
  368.  
  369.      To run MegaMail with SLBBS...
  370.  
  371.      Doors.def:
  372.      0;0;1;50;MegaMail;d:\bbs1;mega.bat %O <- multinode only
  373.  
  374.      Mega.bat:
  375.      @echo off
  376.      utidoor utidoor.txt
  377.      SLQDOOR LOG MEGAMAIL
  378.      megadoor megacfg.%1 utidoor.txt
  379.      SLQDOOR !LOG MEGAMAIL
  380.  
  381.      Run SLQDoor.exe without any parameters to bring up a help screen.
  382.  
  383.  
  384.    USING TIME DOORS
  385.  
  386.      SLQDoor allows you to use Time Banks, and other doors that modify
  387.      the users time, even if they are not written for Searchlight.
  388.      Any door that uses the drop files for the BBS (and does not need
  389.      to modify BBS data files) will work.  The current supported door
  390.      types are GAP, QuickBBS 2.75, and RemoteAccess 1.10.  Wildcat 3.xx,
  391.      PCBoard 14.x, Spitfire 3.x, and others will be added in future
  392.      versions of SLQDoor.
  393.  
  394.      For an example, see the preceding entry for RATS (RA Time Bank).
  395.      When the user exits RATS, and SLQDOOR !RA RATS is executed, SLQDoor
  396.      reads in the EXITINFO.BBS and adjusts the user's time accordingly.
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                                    Page 7
  412.  
  413.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  414.  
  415.  
  416.  
  417.  
  418.    USING PCBVerify
  419.  
  420.      PCBVerify works very well with Searchlight.  Now that SLQDoor
  421.      support PCBVerify directly, it's even easier!
  422.  
  423.      You MUST have a seperate PCBVerify Config File for each node if
  424.      you are running multi-node!  Even if you are only using PCBVerify
  425.      on one of your nodes, still use the node number for that node!
  426.  
  427.      Use PCBV[node #].CFG for the name (PCBV.CFG for single node)
  428.  
  429.      PCBV1.CFG   for node 1
  430.      PCBV2.CFG   for node 2
  431.      etc.
  432.  
  433.      If you are running single node, ignore all references to [node #].
  434.  
  435.  
  436.      PCBVerify Configuration File
  437.  
  438.        The following lines MUST be set in your PCBV[node #].CFG file.
  439.  
  440.          Line 4   PCBV[node #].SYS          (PCBV.SYS for single node)
  441.  
  442.          Line 5   PCBVSYS
  443.  
  444.          Line 8   REG[node #]               (REG for single node)
  445.  
  446.          Line 9   PCBV[node #].LOG          (PCBV.LOG for single node)
  447.  
  448.          Line 10  [your SL newuser security level]
  449.  
  450.  
  451.      PCBVerify Batch File
  452.  
  453.        SLQDOOR [path to PCBVerify]\PCBV PCBV
  454.        PCBV40 PCBV[node #].CFG [/NETWORK]
  455.        SLQDOOR [path to PCBVerify]\!PCBV PCBV
  456.  
  457.      Use the /NETWORK switch on the command line if you are running
  458.      multi-node.  Single node systems do not need it.
  459.  
  460.      PCBVerify will create a file called REG[node #] if the user was
  461.      successfully validated.  If this file exists, SLQDoor will delete
  462.      it, then SLQDoor will update the User to the Validated User Access,
  463.      as defined in CONFIG.SL2.  It will also update the on-line time
  464.      remaining, taking into account Events and Session Time Limits!
  465.  
  466.      The rest of the info on setting up PCBVerify is in the PCBV docs.
  467.  
  468.  
  469.  
  470.                                    Page 8
  471.  
  472.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  473.  
  474.  
  475.  
  476.  
  477.    THE LOG FILE
  478.  
  479.      SLQDoor creates a log file of the date, time, door name, user's
  480.      name, and whether the user is going in or out of the door.
  481.      SLQDoor errors are also logged.  The name of this file is
  482.      SLQD[node#].LOG, and it is located in the SLQDoor directory.
  483.      The log file is names SLQD.LOG for single node systems.
  484.  
  485.      The SLQDoor Log File looks like this:
  486.  
  487.        [date]  [time]  [IN/OUT]   [doorname]  [user name]
  488.  
  489.      or, if an error occurs:
  490.  
  491.      * [date]  [time]  ERR  [doorname]  [error message]
  492.  
  493.  
  494.    ERRORLEVELS
  495.  
  496.      SLQDoor Exits with the following Errorlevels:
  497.  
  498.      Errorlevel     Meaning
  499.      --------------------------------------------------------------------
  500.          0          SLQDoor ran successfully
  501.          1          Error Accessing Searchlight Data Files
  502.          2          Invalid Command Line
  503.          3          Error Writing/Reading a Door Drop File
  504.          4          Error Writing the Log File
  505.          5          Could not find SLQDOOR.CFG
  506.          6          Error Reading SLQDOOR.CFG
  507.  
  508.  
  509.    REGISTRATION
  510.  
  511.      SLQDoor is distributed as ShareWare.  There is a trial period
  512.      of forty-five days in which you may evaluate SLQDoor.  At the end
  513.      of forty-five days, if you have not registered SLQDoor, then you
  514.      may NOT continue using it.  Please read the DISCLAIMER & SHAREWARE
  515.      AGREEMENT earlier in the documentation for more information.
  516.  
  517.      To Register SLQDoor, fill out the enclosed registration form!
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.                                    Page 9
  530.  
  531.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  532.  
  533.  
  534.  
  535.  
  536.    TECHNICAL SUPPORT
  537.  
  538.      USA
  539.  
  540.        A.B.S.
  541.        P.O. Box 55647
  542.        Jackson, MS 39296-5647
  543.        601-362-7599  9am-6pm CST
  544.  
  545.        The Big Bang Theory BBS
  546.        601-366-1664 (v.32bis/HST)
  547.  
  548.        CIS       70740,450
  549.        SL_Net    250:302/532
  550.        FidoNet   1:3632/104
  551.  
  552.  
  553.      NEW ZEALAND
  554.  
  555.        John Clarke
  556.        Online Support BBS
  557.        64-3-772-324 (v.32)
  558.        64-3-667-324 (2400)
  559.  
  560.        SL_Net    250:700/578
  561.        FidoNet   3:700/120
  562.  
  563.  
  564.    OTHER DOOR FORMATS
  565.  
  566.      We are ALWAYS looking for new or updated door formats.  Please send
  567.      any information to the above BBS!
  568.  
  569.  
  570.    FUTURE ENHANCEMENTS
  571.  
  572.      * Complete door usage log, with ANSI & ASCII Reports.
  573.      * ! Support for WC 3.xx, Spitfire 3.x, and PCBoard 14.x
  574.  
  575.  
  576.    ACKNOWLEDGMENTS
  577.  
  578.      * MS-DOS is a registered trademark of Microsoft Corporation
  579.      * All other programs are (c) and/or (tm) by their respective
  580.        author unless otherwise noted
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.                                    Page 10
  589.  
  590.       SLQDoor 2.20 Copyright (c) 1991,1992 A.B.S. - ALL RIGHTS RESERVED
  591.